api: fix scale or upgrade systemvm #11062

weizhouapache · 2025-06-20T13:03:29Z

Description

This PR fixes an issue when scale systemvm, when "allow.diskoffering.change.during.scale.vm" is set to "true"

refer to https://lists.apache.org/thread/0znvzpb4kftx9h1pooso63xvtzgkxzhy

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

codecov · 2025-06-20T13:11:51Z

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 15.18%. Comparing base (67a1ea3) to head (edd3b58).
⚠️ Report is 22 commits behind head on 4.19.

Files with missing lines	Patch %	Lines
...k/api/command/admin/systemvm/ScaleSystemVMCmd.java	0.00%	1 Missing ⚠️
...api/command/admin/systemvm/UpgradeSystemVMCmd.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.19   #11062   +/-   ##
=========================================
  Coverage     15.18%   15.18%           
  Complexity    11365    11365           
=========================================
  Files          5415     5415           
  Lines        475868   475868           
  Branches      58092    58092           
=========================================
  Hits          72252    72252           
  Misses       395531   395531           
  Partials       8085     8085

Flag	Coverage Δ
uitests	`4.28% <ø> (ø)`
unittests	`15.90% <0.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

weizhouapache · 2025-06-25T13:24:29Z

@blueorangutan package

blueorangutan · 2025-06-25T13:26:03Z

@weizhouapache a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-25T14:19:17Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13912

weizhouapache · 2025-06-25T14:54:07Z

@blueorangutan test

blueorangutan · 2025-06-25T14:56:04Z

@weizhouapache a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-06-26T05:03:40Z

[SF] Trillian test result (tid-13602)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 48039 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11062-t13602-kvm-ol8.zip
Smoke tests completed. 133 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

weizhouapache · 2025-07-10T01:56:41Z

@blueorangutan package

blueorangutan · 2025-07-10T01:58:04Z

@weizhouapache a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-07-10T03:05:40Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14126

weizhouapache · 2025-07-10T03:59:12Z

@blueorangutan test keepEnv

blueorangutan · 2025-07-10T04:00:04Z

@weizhouapache a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-07-10T18:04:40Z

[SF] Trillian test result (tid-13746)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 47800 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11062-t13746-kvm-ol8.zip
Smoke tests completed. 133 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

DaanHoogland · 2025-07-14T05:44:17Z

@weizhouapache , you are still working on this right?

weizhouapache · 2025-07-14T06:12:32Z

@weizhouapache , you are still working on this right?

@DaanHoogland
this is ready for review/testing

Copilot

Pull Request Overview

This PR ensures that the details parameter for both Scale and Upgrade System VM commands is properly converted into a Map when disk offering changes are allowed during scaling.

Changed getDetails() in both commands to call convertDetailsToMap(details) instead of returning the raw array.
Applies to UpgradeSystemVMCmd and ScaleSystemVMCmd under the api module.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/UpgradeSystemVMCmd.java	Updated `getDetails()` to convert the raw array to a `Map`
api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java	Updated `getDetails()` to convert the raw array to a `Map`

Comments suppressed due to low confidence (2)

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/UpgradeSystemVMCmd.java:73

Consider updating the Javadoc for getDetails to reflect that the raw details array is now converted into a Map using convertDetailsToMap, improving clarity for API consumers.

        return convertDetailsToMap(details);

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java:79

Add unit tests for getDetails in ScaleSystemVMCmd to verify that various detail inputs (including null and malformed entries) are correctly parsed by convertDetailsToMap.

        return convertDetailsToMap(details);

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java

DaanHoogland

@weizhouapache , these already are Map<String, String>s. Why is the conversions from Map to Map<String, String> needed?

weizhouapache · 2025-07-14T12:55:03Z

@weizhouapache , these already are Map<String, String>s. Why is the conversions from Map to Map<String, String> needed?

The details parameter looks like

details[0].cpunumber=2

it is not ready for use. we need to convert it to

details["cpunumber"]="2"

you may refer to #7769

cc @DaanHoogland

DaanHoogland · 2025-07-14T13:44:17Z

you may refer to #7769

Ah, forgot about that one, thanks for reminding.

DaanHoogland

clgtm

rosi-shapeblue

LGTM - tested and verified the PR

Test Cases Executed and Status

Test Case 1: Scale Secondary Storage VM WITH Details;

Objective: Verify ScaleSystemVMCmd handles details parameter conversion;
Status: PASSED

Test Case 2: Scale Console Proxy VM WITH Details;

Objective: Test scaling on different SystemVM type with details;
Status: PASSED

Test Case 3: Scale Secondary Storage VM WITHOUT Details (Backward Compatibility);

Objective: Ensure backward compatibility without details parameter
Status: PASSED

Test Case 4: Scale Virtual Router WITH Details;

Objective: Test exact scenario from original bug report;
Status: PASSED

Test Case 5: Scale Virtual Router WITHOUT Details (Backward Compatibility)

Objective: Ensure VR backward compatibility without details;
Status: PASSED

Test Case 6: Upgrade routertempalte

Objective Ensure router template can be upgraded without exceptions
Status: PASSED

Overall Success Rate: 6/6 (100%)

Logs were checked during the test cases executions - no NullPointerException was observed.

Evidence

Test Case 1: Scale Secondary Storage VM WITH Details

(localcloud) 🐱 > scale systemvm id=9e08d9a2-74bb-42af-b3ed-a7528deb4b38 serviceofferingid=9df61822-f6fa-40e6-843a-a600ad7096e6 details[0].key=test_reason details[0].value=testing_pr_11062 details[1].key=qa_engineer details[1].value=rositsa_kyuchukova
{
  "systemvm": {
    "agentstate": "Disconnected",
    "created": "2025-08-06T21:57:58+0000",
    "dns1": "10.0.32.1",
    "dns2": "8.8.8.8",
    "gateway": "10.0.48.1",
    "hasannotations": false,
    "hypervisor": "KVM",
    "id": "9e08d9a2-74bb-42af-b3ed-a7528deb4b38",
    "isdynamicallyscalable": false,
    "name": "s-1-VM",
    "podid": "8f098bb8-5990-43d6-a0f1-852970f73c2f",
    "podname": "Pod1",
    "publicip": "10.0.58.61",
    "publicmacaddress": "1e:00:a6:00:00:01",
    "publicnetmask": "255.255.240.0",
    "serviceofferingid": "9df61822-f6fa-40e6-843a-a600ad7096e6",
    "serviceofferingname": "SystemVM-Small",
    "state": "Stopped",
    "systemvmtype": "secondarystoragevm",
    "templateid": "74f2261d-730d-11f0-a1e2-1e00ef00046b",
    "templatename": "SystemVM Template (KVM)",
    "version": "4.19.4.0-SNAPSHOT",
    "zoneid": "c245525e-448f-48ed-8a8f-c6194edc6988",
    "zonename": "ref-trl-9185-k-Mol8-rositsa-kyuchukova"
  }
}

Test Case 2: Scale Console Proxy VM WITH Details

(localcloud) 🐱 > scale systemvm id=bccc6765-84ed-4091-b3c6-6ad98a31612d serviceofferingid=399e0202-738d-4b32-8bb8-a7f659653307 details[0].key=vm_type details[0].value=consoleproxy details[1].key=test_case details[1].value=scale_with_details
{
  "systemvm": {
    "activeviewersessions": 0,
    "agentstate": "Disconnected",
    "created": "2025-08-06T21:57:59+0000",
    "dns1": "10.0.32.1",
    "dns2": "8.8.8.8",
    "gateway": "10.0.48.1",
    "hasannotations": false,
    "hypervisor": "KVM",
    "id": "bccc6765-84ed-4091-b3c6-6ad98a31612d",
    "isdynamicallyscalable": false,
    "name": "v-2-VM",
    "podid": "8f098bb8-5990-43d6-a0f1-852970f73c2f",
    "podname": "Pod1",
    "publicip": "10.0.58.62",
    "publicmacaddress": "1e:00:32:00:00:02",
    "publicnetmask": "255.255.240.0",
    "serviceofferingid": "399e0202-738d-4b32-8bb8-a7f659653307",
    "serviceofferingname": "SystemVM-Medium",
    "state": "Stopped",
    "systemvmtype": "consoleproxy",
    "templateid": "74f2261d-730d-11f0-a1e2-1e00ef00046b",
    "templatename": "SystemVM Template (KVM)",
    "version": "4.19.4.0-SNAPSHOT",
    "zoneid": "c245525e-448f-48ed-8a8f-c6194edc6988",
    "zonename": "ref-trl-9185-k-Mol8-rositsa-kyuchukova"
  }
}

Test Case 3: Scale Secondary Storage VM WITHOUT Details

(localcloud) 🐱 > scale systemvm id=9e08d9a2-74bb-42af-b3ed-a7528deb4b38 serviceofferingid=399e0202-738d-4b32-8bb8-a7f659653307
{
  "systemvm": {
    "agentstate": "Disconnected",
    "created": "2025-08-06T21:57:58+0000",
    "dns1": "10.0.32.1",
    "dns2": "8.8.8.8",
    "gateway": "10.0.48.1",
    "hasannotations": false,
    "hypervisor": "KVM",
    "id": "9e08d9a2-74bb-42af-b3ed-a7528deb4b38",
    "isdynamicallyscalable": false,
    "name": "s-1-VM",
    "podid": "8f098bb8-5990-43d6-a0f1-852970f73c2f",
    "podname": "Pod1",
    "publicip": "10.0.58.61",
    "publicmacaddress": "1e:00:a6:00:00:01",
    "publicnetmask": "255.255.240.0",
    "serviceofferingid": "399e0202-738d-4b32-8bb8-a7f659653307",
    "serviceofferingname": "SystemVM-Medium",
    "state": "Stopped",
    "systemvmtype": "secondarystoragevm",
    "templateid": "74f2261d-730d-11f0-a1e2-1e00ef00046b",
    "templatename": "SystemVM Template (KVM)",
    "version": "4.19.4.0-SNAPSHOT",
    "zoneid": "c245525e-448f-48ed-8a8f-c6194edc6988",
    "zonename": "ref-trl-9185-k-Mol8-rositsa-kyuchukova"
  }
}

Test Case 4: Scale Virtual Router WITH Details

(localcloud) 🐱 > scale systemvm id=b26cfc47-c26e-4071-80c7-6f273a1ce402 serviceofferingid=9df61822-f6fa-40e6-843a-a600ad7096e6 details[0].key=test_reason details[0].value=testing_pr_11062_virtual_router details[1].key=qa_engineer details[1].value=rositsa_kyuchukova
{
  "systemvm": {
    "created": "2025-08-08T08:41:17+0000",
    "dns1": "10.0.32.1",
    "dns2": "8.8.8.8",
    "gateway": "10.0.48.1",
    "hasannotations": false,
    "hypervisor": "KVM",
    "id": "b26cfc47-c26e-4071-80c7-6f273a1ce402",
    "isdynamicallyscalable": false,
    "name": "r-4-VM",
    "podid": "8f098bb8-5990-43d6-a0f1-852970f73c2f",
    "podname": "Pod1",
    "publicip": "10.0.58.63",
    "publicmacaddress": "1e:00:fc:00:00:03",
    "publicnetmask": "255.255.240.0",
    "serviceofferingid": "9df61822-f6fa-40e6-843a-a600ad7096e6",
    "serviceofferingname": "SystemVM-Small",
    "state": "Stopped",
    "systemvmtype": "domainrouter",
    "templateid": "74f2261d-730d-11f0-a1e2-1e00ef00046b",
    "templatename": "SystemVM Template (KVM)",
    "zoneid": "c245525e-448f-48ed-8a8f-c6194edc6988",
    "zonename": "ref-trl-9185-k-Mol8-rositsa-kyuchukova"
  }
}

Test Case 5: Scale Virtual Router WITHOUT Details

(localcloud) 🐱 > scale systemvm id=b26cfc47-c26e-4071-80c7-6f273a1ce402 serviceofferingid=399e0202-738d-4b32-8bb8-a7f659653307
{
  "systemvm": {
    "created": "2025-08-08T08:41:17+0000",
    "dns1": "10.0.32.1",
    "dns2": "8.8.8.8",
    "gateway": "10.0.48.1",
    "hasannotations": false,
    "hypervisor": "KVM",
    "id": "b26cfc47-c26e-4071-80c7-6f273a1ce402",
    "isdynamicallyscalable": false,
    "name": "r-4-VM",
    "podid": "8f098bb8-5990-43d6-a0f1-852970f73c2f",
    "podname": "Pod1",
    "publicip": "10.0.58.63",
    "publicmacaddress": "1e:00:fc:00:00:03",
    "publicnetmask": "255.255.240.0",
    "serviceofferingid": "399e0202-738d-4b32-8bb8-a7f659653307",
    "serviceofferingname": "SystemVM-Medium",
    "state": "Stopped",
    "systemvmtype": "domainrouter",
    "templateid": "74f2261d-730d-11f0-a1e2-1e00ef00046b",
    "templatename": "SystemVM Template (KVM)",
    "zoneid": "c245525e-448f-48ed-8a8f-c6194edc6988",
    "zonename": "ref-trl-9185-k-Mol8-rositsa-kyuchukova"
  }
}

Test Case 6: Upgrade routertempalte

Results from logs:

tail -f /var/log/cloudstack/management/management-server.log | grep -i upgrade
2025-08-08 09:48:54,463 DEBUG [c.c.a.ApiServlet] (qtp253011924-21:[ctx-3322079d]) (logid:acd2031b) ===START===  10.0.35.125 -- GET  apiKey=LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q&command=upgradeRouterTemplate&id=3005fd3c-db83-4445-b244-c0989ef83ef7&response=json&signature=TASc72okjoYs6FkwhVuCUnrmTFA%3D
2025-08-08 09:48:54,476 DEBUG [c.c.n.r.VpcVirtualNetworkApplianceManagerImpl] (qtp253011924-21:[ctx-3322079d, ctx-62d458ee, ctx-d60beb70]) (logid:acd2031b) Router: VM instance {"id":5,"instanceName":"r-5-VM","state":"Running","type":"DomainRouter","uuid":"3005fd3c-db83-4445-b244-c0989ef83ef7"} is already at the latest version. No upgrade required
2025-08-08 09:48:54,476 DEBUG [c.c.a.ApiServlet] (qtp253011924-21:[ctx-3322079d, ctx-62d458ee, ctx-d60beb70]) (logid:acd2031b) ===END===  10.0.35.125 -- GET  apiKey=LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q&command=upgradeRouterTemplate&id=3005fd3c-db83-4445-b244-c0989ef83ef7&response=json&signature=TASc72okjoYs6FkwhVuCUnrmTFA%3D

weizhouapache · 2025-08-08T12:06:56Z

@rosi-shapeblue
Thanks for the brilliant testing

api: fix scale or upgrade systemvm

660eef7

boring-cyborg bot added the component:api label Jun 20, 2025

weizhouapache marked this pull request as ready for review July 10, 2025 01:56

Merge branch '4.19' into 4.19-fix-scale-systemvm

edd3b58

DaanHoogland added the status:needs-testing label Jul 14, 2025

DaanHoogland requested review from Copilot and removed request for Copilot July 14, 2025 11:12

Copilot AI reviewed Jul 14, 2025

View reviewed changes

api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java Show resolved Hide resolved

DaanHoogland reviewed Jul 14, 2025

View reviewed changes

DaanHoogland approved these changes Jul 14, 2025

View reviewed changes

rosi-shapeblue self-assigned this Aug 6, 2025

rosi-shapeblue approved these changes Aug 8, 2025

View reviewed changes

rosi-shapeblue removed the status:needs-testing label Aug 8, 2025

sureshanaparti added this to the 4.19.4 milestone Aug 8, 2025

sureshanaparti merged commit 78e1462 into apache:4.19 Aug 8, 2025
25 of 26 checks passed

weizhouapache deleted the 4.19-fix-scale-systemvm branch August 8, 2025 12:07

dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Sep 4, 2025

api: fix scale or upgrade systemvm (apache#11062)

ced5e89

api: fix scale or upgrade systemvm #11062

api: fix scale or upgrade systemvm #11062

Uh oh!

Conversation

weizhouapache commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

weizhouapache commented Jun 25, 2025

Uh oh!

blueorangutan commented Jun 25, 2025

Uh oh!

blueorangutan commented Jun 25, 2025

Uh oh!

weizhouapache commented Jun 25, 2025

Uh oh!

blueorangutan commented Jun 25, 2025

Uh oh!

blueorangutan commented Jun 26, 2025

Uh oh!

weizhouapache commented Jul 10, 2025

Uh oh!

blueorangutan commented Jul 10, 2025

Uh oh!

blueorangutan commented Jul 10, 2025

Uh oh!

weizhouapache commented Jul 10, 2025

Uh oh!

blueorangutan commented Jul 10, 2025

Uh oh!

blueorangutan commented Jul 10, 2025

Uh oh!

DaanHoogland commented Jul 14, 2025

Uh oh!

weizhouapache commented Jul 14, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

DaanHoogland left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weizhouapache commented Jul 14, 2025 • edited by DaanHoogland Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DaanHoogland commented Jul 14, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

rosi-shapeblue left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Test Cases Executed and Status

Evidence

Uh oh!

Uh oh!

weizhouapache commented Aug 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

weizhouapache commented Jun 20, 2025 •

edited

Loading

codecov bot commented Jun 20, 2025 •

edited

Loading

DaanHoogland left a comment •

edited

Loading

weizhouapache commented Jul 14, 2025 •

edited by DaanHoogland

Loading

rosi-shapeblue left a comment •

edited

Loading